home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / clipboard / clipbook / clipbook.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  20KB  |  405 lines
  1. @DATABASE "Clipbook.guide"
  2. @VER 1.1
  3. @INDEX ClB_Index/MAIN
  4. @NODE MAIN " Clipbook                            Copyright 
  5.  1994, Nick Portalski"
  6. @NEXT OVERVIEW
  7. @TOC COMPCONT 
  8.                   ClipBook V1.2  
  9.  1994 Nick Portalski
  10.                  =======================================
  11.     @{" Overview                " link OVERVIEW  }
  12.     @{" Improvements since 1.1  " link IMPROV }
  13.     @{" Distribution            " link DIST }
  14.     @{" Requirements            " link REQ }
  15.     @{" Installation            " link INTS }
  16.     @{" Usage                   " link USE }
  17.     @{" Options                 " link OPTS}
  18.     @{" Supported Clips         " link SUCL}
  19.     @{" Additional Notes        " link ADD }
  20.     @{" History                 " link HIST}
  21.     @{" Bugs                    " link BUGS}
  22.     @{" Future                  " link FUT}
  23.     @{" Thanks To...            " link TNK}
  24.     @{" Not Only But Also       " link NOB}
  25. @EndNode
  26. @Node OVERVIEW "Clipbook - Overview"
  27. @PREV MAIN
  28. @NEXT IMPROV
  29. Overview
  30. ========
  31. I spent a couple of summers working on Macs writing documentation.  One of
  32. the most useful tools was the Mac Scrapbook, which allows you to store any
  33. number of 'clips' (text and graphics) and then copy any one to the clipboard 
  34. so you can paste it into applications.  Items were placed in the scrapbook 
  35. via the normal cut'n'paste keys.  In fact, I liked it so much that I wrote 
  36. this -  Amiga Clipbook commodity.
  37. So, the Clipbook allows you to store text and graphics clips, scan through
  38. them and copy any of them to the standard Amiga clipboard.  They can then 
  39. be pasted into applications.  To put something into the Clipbook you simply
  40. have to copy it from an application and paste it into the Clipbook.
  41. Because the Clipbook visually displays a clip you won't ever waste time
  42. by loading the wrong picture or needing to print them all out.
  43. This is useful for logos, 'standard' blocks of text, graphics you use
  44. often etc etc.  If you use a particular graphics brush often then instead of
  45. having to load it (and remember the path!) each time you can simply store
  46. it in the clipboard and copy it out each time you need it. 
  47. It is important to remember that this will only work with applications
  48. which use the standard Amiga Clipboard. (DPaint AGA, Ced, FinalWriter
  49. the SAS/C SE editor etc).
  50. @EndNode
  51. @Node IMPROV "Clipbook - Improvments since 1.1"
  52. @PREV OVERVIEW
  53. @NEXT DIST
  54. Improvements since V1.1
  55. ========================
  56. Added detection of D2RD clips. Hope to actually draw them soon....
  57. Added AutoPaste.  If this is turned on then Clipbook will monitor the
  58. clipboard.  When something is pasted into the clipboard it will
  59. automatically be inserted into the Clipbook.  Useful if you're trying
  60. to get a lot of clips into the Clipbook at once.
  61. You can now name clips.
  62. The Paste menu item is now ghosted when there's nothing in the 
  63. clipboard.
  64. You can now specify different viewers for ilbm/ftxt/other clips
  65. Fixed some enforcer hits!  As far as I know there are no longer any
  66. hits.  (All bug reports to my @{"e-mail" link NOB}...)
  67. Improvments since 1.0
  68. =====================
  69. You can now load a clip into the Clipbook from a file.  This is useful
  70. if, say, your graphics program doesn't use the Amiga clipboard.
  71. The current clip number is held even when you close the window.  This means
  72. you won't be taken to the first clip every time the window is opened.
  73. Better FTXT handling (Especially useful for FinalWriter text.....)
  74. Extra info about non-standard clips displayed.
  75. Added in a few more keys 'cos someone asked me to.
  76. See @{"History" link HIST}.
  77. @EndNode
  78. @Node DIST "Clipbook - Distribution"
  79. @PREV IMPROV
  80. @NEXT REQ
  81. Distribution
  82. ============
  83. All code is Copyright 1994 Nick Portalski.  It may be copied and distributed 
  84. so long as no commercial profit is made out of it.  It may not be modified, 
  85. sold, or included in any commercial distribution without my written 
  86. permission. Public Domain vendors are not allowed to sell this program for 
  87. more than the price of a regular disk, which should be no more than the 
  88. equivalent of 5 Dollars. (It may be placed on CD-ROM collections costing
  89. more than this). The author takes no responsibility for any loss or damage 
  90. resulting from the use of this program.
  91. This distribution should contain the following files:
  92.     ClipBook
  93.     ClipBook.info
  94.     ClipBook.doc
  95.     ClipBook.doc.info
  96.     ClipBook.guide
  97.     ClipBook.guide.info
  98.     iff.library
  99. @EndNode
  100. @Node REQ "Clipbook - Requirements"
  101. @PREV DIST
  102. @NEXT INTS
  103. Requirements
  104. ============
  105. * Workbench 2.xx+
  106. * The iff.library by Christian Weber (included in archive).
  107. * Although Clipbook will run happily from floppy it has been designed with 
  108.   hard drive users in mind.
  109. @EndNode
  110. @Node INTS "Clipbook - Installation"
  111. @PREV REQ
  112. @NEXT USE
  113. Installation
  114. ============
  115. Clipbook is a commodity - so you can either copy it into the WBStartup 
  116. directory or simply run it when you need it.  As it uses tooltypes stored
  117. in the icon you must copy the .info file too.  If you want to display
  118. ILBM pictures in the clipbook you must copy iff.library to your libs:
  119. directory. Clipbook should only be used from the Workbench.
  120. You should also decide where you want clips to be stored.  I suggest
  121. you create a new directory.  Specify the path to this directory in
  122. the icon's CLIPDIR tooltype. See @{"Options" link OPTS}.
  123. When you first run the Clipbook you will be asked "Can't find .cliprc.
  124. Create new one?"  Answer "Yes" - this creates a control file required
  125. in the CLIPDIR.  See @{"Additional Notes" link ADD} for more info.
  126. @EndNode
  127. @Node USE "Clipbook - Usage"
  128. @PREV INTS
  129. @NEXT OPTS
  130. Usage
  131. =====
  132. Once run the Clipbook window will appear when you press the hotkey specified
  133. in the tooltype. (Or use the Commodity Exchange program to show its 
  134. interface).  By default it appears on the Workbench screen, but you can 
  135. force it to appear on other screens. See @{"Options" link OPTS}.
  136. The main part of the window shows the current 'clip', with the rest being 
  137. made up of gadgets.
  138. The slider gadget at the bottom allows you to move through all the clips
  139. in the clipbook.  The text below the clip gives you information about the
  140. clips (i.e. what type it is) (See @{"Supported Clips" link SUCL})and how many clips 
  141. there are in total.
  142. The 'View Scrap' button will launch the VIEWER program you have specified
  143. in the tooltypes (see Options below) for the current clip type.  This is the 
  144. best way to see a clip in full, as the window only displays a small portion.
  145. Also, the Clipbook will not try to work out the colours of ILBM clips, 
  146. whereas a viewer such as Multiview will.  You can specify different viewers
  147. for FTXT (text), ILBM (graphics) and other clips. (See @{"Options" link OPTS})
  148. The 'Name' string allows you to enter up to 64 characters for a clip's
  149. name.  This is extremely useful for clips which Clipbook can't
  150. display (e.g. FinalWriter grapics) as you can still identity them!
  151. To close the Clipbook click on the window's close gadget.  The Clipbook will
  152. remain resident and can be displayed with the hotkey again.  The 'Remove'
  153. button will close the Clipbook window *and* remove it from memory, whereas
  154. 'Hide' will simply close the window and leave Clipbook resident.
  155. There are 2 menus:
  156. The first is fairly straightforward:
  157.     Project -> Next Clip     :  Moves to the next clip in the clipbook
  158.     Project -> Previous Clip :  Move to the previous clip in the clipbook
  159.     Project -> AutoPaste     :  With this option turned on anything copied
  160.                                 to the clipboard will automatically be
  161.                                 inserted into the Clipbook. (EXCEPT items
  162.                                 which are copied from the Clipbook itself)
  163.     Project -> Load Clip From File : See below.
  164.     Project -> Remove        :  Removes the Clipbook from memory
  165.     Project -> Hide          :  Closes the Clipbook window, but leaves the
  166.                                 program resident.
  167. Load Clip From File : Although text programs have used the Amiga clipboard
  168.                       for some time, a certain well-known graphics program
  169.                       has only just started using it.  On earlier versions it
  170.                       was impossible to get graphics clips into the Clipbook.
  171.                       However, selecting this menu option will prompt you
  172.                       for a file.  Select any IFF file (e.g. graphics)
  173.                       and it will load it and paste it into the Clipbook.
  174.                       This function does make some basic checks on the 
  175.                       file to check it's IFF, but it is possible to fool it.
  176. The second menu is used to paste items into the Clipbook and to copy them 
  177. out. This uses the standard Amiga Clipboard, and the menu shortcut keys are
  178. the ones you'd expect for Cut/Copy/Paste.
  179. In general, to place something into the Clipbook, 'Copy' it to the clipboard
  180. in an application, switch to the Clipbook and select 'Paste'.  The item will
  181. be added to the Clipbook at the current position. (It *doesn't* overwrite
  182. anything).
  183. To get a clip from the Clipbook to an Application you have two choices.
  184. 'Copy' places a copy of the current clip in the Clipboard.  You can then 
  185. go to an application and choose Paste.  Alternatively 'Cut' will remove
  186. the current clip from the Clipbook and place it in the Clipboard.
  187. Clear deletes the current clip without affecting the clipboard.
  188. However, to copy from or paste to an application that application must
  189. support the standard Amiga clipboard.  Fortunately more and more are.
  190. Other Keys
  191. ==========
  192. As well as the menu short-cut keys there are 5 others:
  193. Cursor Left -   Next Clip
  194. Cursor Right-   Previous Clip
  195. Cursor Up       Last Clip
  196. Cursor Down     First clip
  197. Return          Copy current clip to clipboard and close Clipbook window
  198. Combined with the hotkey these make getting a clip out of the Clipbook
  199. very quick and easy, as they're all one-key operations.
  200. @EndNode
  201. @Node OPTS "Clipbook - Options"
  202. @PREV USE
  203. @NEXT SUCL
  204. Options
  205. =======
  206. All options are given via the tooltypes of Clipbook's icon.  If not
  207. present default values are used:
  208. CX_POPUP    :  If 'YES' the Clipbook Window will open when the program 
  209.                is run. Default = NO
  210. CX_POPKEY   :  Hotkey to open the Clipbook Window. 
  211.                Default is Control Left Alt s
  212. CLIPDIR     :  The name of the directory where clips are to be stored.  If
  213.                not present the Clipbook will default to CLIPS:, but this is
  214.                usually assigned to RAM:, so clips will not be permanent.
  215.                If the specified directory doesn't exist you'll be informed
  216.                and the program will quit when you try to open the window.
  217.                If there is no .cliprc file in the specified directory you
  218.                will be asked if you want to create an (empty) one.  
  219.                Answering 'No' will quit the program as it can't run without
  220.                a .cliprc!
  221. ILBM_VIEWER :  The name of the graphics viewer to be run when the 
  222.                'View Scrap' button is pressed and the current clip is ILBM.  
  223.                This should include the full path and any arguments to the 
  224.                viewer.  
  225.                For example, I use:
  226.                          'sys:utilities/multiview SCREEN'
  227.                Default is sys:utilities/multiview SCREEN
  228. TEXT_VIEWER :  As ILBM_VIEWER but used to view FTXT clips.
  229. VIEWER      :  As above but used for any clips which aren't ILBM or FTXT.
  230. PUBLICSCREEN:  The name of the Publicscreen the Clipbook is to open on.  If
  231.                this isn't specified or the specified screen doesn't exist
  232.                Workbench is used.
  233. FORCETOFRONT:  If this tooltype is present the Clipbook will always open on
  234.                the frontmost screen when the hotkey is pressed - regardless
  235.                of whether it's a publicscreen or not.  Obviously this can be
  236.                very useful but does carry dangers.  The program which opened
  237.                the screen may not be expecting a window to open and you must
  238.                never try to quit the screen's program before closing the 
  239.                Clipbook window.  I cannot guarantee correct operation of the
  240.                Clipbook when forced to open on the frontmost screen.  It does
  241.                seem to work with Ced (with system scrolling routines), 
  242.                Devpac, FinalWriter, FinalCopy, ProPage and to some extent 
  243.                DPaint.
  244.                Default is not to force to front.
  245. AUTOPASTE:     This determines the initial state of the AutoPaste menu item.
  246. @EndNode
  247. @Node SUCL "Clipbook - Supported Clips"
  248. @PREV OPTS
  249. @NEXT 
  250. Supported Clips
  251. ===============
  252. You can actually paste any type of 'Clip' from the Amiga Clipboard
  253. into the Clipbook.  However, it will currently only display two types.
  254. FTXT:   This is standard text.
  255. ILBM:   This is graphics.  You'll need iff.library for this to work.
  256. SWRT:   The type of clip is used by Softwood (e.g. FinalWriter).  The
  257.         Clipbook can store these but can't currently display them.
  258.         So, for example, you can draw some structured graphics in 
  259.         FinalWriter, select them, select 'Copy' and then launch the Clipbook.
  260.         You can now use 'Paste', and the clipbook will tell you it can't 
  261.         display it. You can copy/cut it later though and paste it back into 
  262.         FinalWriter.
  263. D2RD:   This is the IFF structured drawing.  Again, Clipbook doesn't
  264.         currently display the clip.
  265. UNKN:   The Clipbook doesn't recognise the clip, but can store it.
  266. NIFF:   (Not IFF) You shouldn't see this type, as all clips must be IFF to
  267.         be stored in the Amiga clipboard.  It therefore indicates that
  268.         something has gone wrong with a file in the CLIPDIR.
  269. In the UNKN case the Clipbook will display additional information.  This
  270. information is the identifier of the first 'chunk' in the clip.  This may
  271. help you remember which application it came from.
  272. There is an additional complication.  When storing FTXT (text) in a clip
  273. an application such as FinalWriter needs to store additional information
  274. such as typeface, style etc.  When you try and paste this into another
  275. application you may not get all the text.  The Clipbook parses FTXT 
  276. properly and displays all the text, but if it thinks there is additional
  277. information in the clip it will display something in brackets after the 
  278. FTXT.  For example, if I copy some text from FinalWriter to the Clipbook
  279. it shows:
  280.         FTXT (FCCH)
  281. This tells you where it's come from and that other applications may not
  282. understand it.
  283. @EndNode
  284. @Node ADD "Clipbook - Additional Notes"
  285. @PREV SUCL
  286. @NEXT HIST
  287. Additional Notes
  288. ================
  289. Each clips stored in the clipbook is stored as a file.  All these files
  290. are stored in the CLIPDIR (see Options below).  A 'control' file called
  291. .cliprc is also stored in this directory, which keeps count of the total
  292. number of clips.  If the program can't find this .cliprc file it will ask
  293. you if you want to create a new one with 0 entries.  If the CLIPDIR is
  294. invalid the program will quit.
  295. You can alter the contents of the CLIPDIR and the .cliprc if you really want
  296. to - but I wouldn't suggest it.  If for some reason the .cliprc file is
  297. deleted you can easily re-initialise it to the number of clips in the
  298. directory.  Simply cd to the CLIPDIR and type:
  299.     echo >.cliprc "X"
  300. Where X is the number of clips in the directory.
  301. Also, be aware that although I can force the Clipbook to open on the 
  302. frontmost screen I can't force the viewer run with the 'View Scrap' button 
  303. (See @{"Options" link OPTS}) to do the same.  If you think this isn't working try 
  304. taking a look at the Workbench screen to see if the viewer's window has appeared 
  305. there. (Although Multiview will autmoatically bring its screen to the front).
  306. @EndNode
  307. @Node HIST "Clipbook - History"
  308. @PREV ADD
  309. @NEXT FUT
  310. The History of ClipBook
  311. ========================
  312. Version 1.0     First Public Release
  313. (14th June 94)
  314. Version 1.1     Made a buffer bigger due to bug in older versions of FGets()
  315. (27th June 94)                
  316.                 Fixed bug when allocating bitmaps. (Probably only affects AGA
  317.                 machines)  This was probably causing the bug I was blaming on
  318.                 DPaint!
  319.                 Added 'Load Clip from File'.
  320.                 The current clip number is now held even when you close the 
  321.                 window.  This means it starts where you left off.
  322.                 Improved FTXT handling.  This now uses iffparse.library.  
  323.                 FinalWriter FTXT clips (normal text) now display properly.
  324.                 However, other applications may not paste the whole clip as
  325.                 FinalWriter may store the text as many chunks in the file.
  326.                 I will add a 'Convert to simple FTXT' feature in future
  327.                 versions.
  328.                 Extra information about clips is now displayed, which is
  329.                 helpful especially for clips of type UNKN.
  330.                 Fixed bug when opening on a publicscreen.  I was releasing 
  331.                 the lock too early.... (Though the chances of this one ever 
  332.                 occuring were tiny!).
  333.                 Made it use NewLookMenus under 3.0->.
  334.                 Added Cursor Left, Right, Up, Down and Return (Copy and Hide)
  335. Version 1.2        Added detection of D2RD clips. Hope to actually draw them soon....
  336. (Sep-Oct '94)
  337.                 Added AutoPaste
  338.                 Added Naming Clips
  339.                 Paste menu item now ghosted when there's nothing in the clipboard
  340.                 Added ability to specify different viewers for ilbm/ftxt/other clips
  341.                 Fixed some enforcer hits!
  342. @EndNode
  343. @Node BUGS "Clipbook - Known Bugs"
  344. @PREV HIST
  345. @NEXT FUT
  346. Known Bugs
  347. ==========
  348. The font adaptive routines (as generated by Gadtoolsbox) aren't great - 
  349. and if you use strange fonts you may find some of the text overlapping
  350. the gadgets.  I will try to sort this out in future versions.
  351. There are risks with opening windows on non-publicscreens.  To be safe
  352. ONLY use the Clipbook when it's open on a non-publiscscreen; don't try and
  353. use the application owning the screen whilst the clipbook is open.
  354. @EndNode
  355. @Node FUT "Clipbook - Future"
  356. @PREV BUGS
  357. @NEXT TNK
  358. Future of Clipbook
  359. ==================
  360. There are several things I want to do with Clipbook.  The first is to be able
  361. to display Softwood clips (e.g. from FinalWriter).  I also hope to add
  362. structured IFF drawings, EPSF displaying  and an AREXX port so that utilities
  363. such as Snap can cut directly to the Clipbook.  This means many screenshots 
  364. could be captured to the Clipbook, which is useful if you're writing a 
  365. manual.
  366. I also want to have an index of names the user can look clips up in.
  367. Make the window re-sizeable.......
  368. Oh yeah, if you've got over about 30 clips pasting a new one in can take
  369. a few seconds whilst the CLIPDIR is shuffled about.  At some point I'll
  370. try to improve on this.
  371. @EndNode
  372. @Node TNK "Clipbook - Thanks To....."
  373. @PREV FUT
  374. @NEXT NOB
  375. Thanks To
  376. =========
  377. * The authors of GadToolsBox.
  378. * Christian Weber for iff.library
  379. * Mark McPherson for the startup code.  
  380. * Matt Jennings for the use of his A3000 (so I could run Enforcer).
  381. * Marcel Offermans for suggesting the functionality of the return key.
  382. @EndNode
  383. @Node NOB "Clipbook - Not Only But Also"
  384. @PREV TNK
  385. Not Only But Also......
  386. ========================
  387. This version of Clipbook is free - although if you do use it I'd appreciate 
  388. somthing to help encourage future updates!  
  389. I would especially like to hear about any applications whose clips it doesn't
  390. recognise.  Sending me an example clip would be very helpful - even the first
  391. page of the output from "type xxxx hex" would be good.
  392. I welcome all bug reports, comments and suggestions and can be contacted
  393. by any of the following means:
  394. e-mail:     nick@ripple.demon.co.uk
  395. snail-mail: Nick Portalski
  396.             24, Scotland Farm Road
  397.             Ash Vale
  398.             Aldershot
  399.             Hants
  400.             GU12 5JB
  401. I hope you find it useful!
  402. Nick Portalski 
  403. November 1994
  404. @EndNode
  405.